<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: LPM (Link Power Management) Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__usbfs__dev__drv__functions__lpm.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">LPM (Link Power Management) Functions<div class="ingroups"><a class="el" href="group__group__usbfs__dev__drv.html">USBFS        (USB Full-Speed Device)</a> &raquo; <a class="el" href="group__group__usbfs__dev__drv__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<p>The LPM functions provide an API to use the LPM feature available in the USB block. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5290ed3e38780181cd2b931b9d39ea99"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__lpm.html#ga5290ed3e38780181cd2b931b9d39ea99">Cy_USBFS_Dev_Drv_Lpm_GetBeslValue</a> (USBFS_Type const *base)</td></tr>
<tr class="memdesc:ga5290ed3e38780181cd2b931b9d39ea99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the Best Effort Service Latency (BESL) value sent by the host as part of the LPM token transaction.  <a href="#ga5290ed3e38780181cd2b931b9d39ea99">More...</a><br /></td></tr>
<tr class="separator:ga5290ed3e38780181cd2b931b9d39ea99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga33b0d0c7b758c9a0d9c499d13cd900f8"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__lpm.html#ga33b0d0c7b758c9a0d9c499d13cd900f8">Cy_USBFS_Dev_Drv_Lpm_RemoteWakeUpAllowed</a> (USBFS_Type const *base)</td></tr>
<tr class="memdesc:ga33b0d0c7b758c9a0d9c499d13cd900f8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the remote wakeup permission set by the Host as part of the LPM token transaction.  <a href="#ga33b0d0c7b758c9a0d9c499d13cd900f8">More...</a><br /></td></tr>
<tr class="separator:ga33b0d0c7b758c9a0d9c499d13cd900f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1e0ca4d1b2ba8009065362cfeec5f078"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__lpm.html#ga1e0ca4d1b2ba8009065362cfeec5f078">Cy_USBFS_Dev_Drv_Lpm_SetResponse</a> (USBFS_Type *base, <a class="el" href="group__group__usbfs__dev__drv__enums.html#ga7e78856f9225afbd18151968ceefbe06">cy_en_usbfs_dev_drv_lpm_req_t</a> response)</td></tr>
<tr class="memdesc:ga1e0ca4d1b2ba8009065362cfeec5f078"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the response in the handshake packet that the device sends when an LPM token packet is received.  <a href="#ga1e0ca4d1b2ba8009065362cfeec5f078">More...</a><br /></td></tr>
<tr class="separator:ga1e0ca4d1b2ba8009065362cfeec5f078"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa199d2bde362568ca193e437fa587a25"><td class="memItemLeft" align="right" valign="top">__STATIC_INLINE <a class="el" href="group__group__usbfs__dev__drv__enums.html#ga7e78856f9225afbd18151968ceefbe06">cy_en_usbfs_dev_drv_lpm_req_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__usbfs__dev__drv__functions__lpm.html#gaa199d2bde362568ca193e437fa587a25">Cy_USBFS_Dev_Drv_Lpm_GetResponse</a> (USBFS_Type const *base)</td></tr>
<tr class="memdesc:gaa199d2bde362568ca193e437fa587a25"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the response value that the device sends as part of the handshake packet when an LPM token packet is received.  <a href="#gaa199d2bde362568ca193e437fa587a25">More...</a><br /></td></tr>
<tr class="separator:gaa199d2bde362568ca193e437fa587a25"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga5290ed3e38780181cd2b931b9d39ea99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5290ed3e38780181cd2b931b9d39ea99">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Lpm_GetBeslValue()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE uint32_t Cy_USBFS_Dev_Drv_Lpm_GetBeslValue </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the Best Effort Service Latency (BESL) value sent by the host as part of the LPM token transaction. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>BESL value (4-bits) </dd></dl>

</div>
</div>
<a id="ga33b0d0c7b758c9a0d9c499d13cd900f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga33b0d0c7b758c9a0d9c499d13cd900f8">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Lpm_RemoteWakeUpAllowed()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE bool Cy_USBFS_Dev_Drv_Lpm_RemoteWakeUpAllowed </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the remote wakeup permission set by the Host as part of the LPM token transaction. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Remote wakeup permission: true - allowed, false - not allowed. </dd></dl>

</div>
</div>
<a id="ga1e0ca4d1b2ba8009065362cfeec5f078"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1e0ca4d1b2ba8009065362cfeec5f078">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Lpm_SetResponse()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE void Cy_USBFS_Dev_Drv_Lpm_SetResponse </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type *&#160;</td>
          <td class="paramname"><em>base</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__usbfs__dev__drv__enums.html#ga7e78856f9225afbd18151968ceefbe06">cy_en_usbfs_dev_drv_lpm_req_t</a>&#160;</td>
          <td class="paramname"><em>response</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures the response in the handshake packet that the device sends when an LPM token packet is received. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
    <tr><td class="paramname">response</td><td>The response to return for an LPM token packet. See <a class="el" href="group__group__usbfs__dev__drv__enums.html#ga7e78856f9225afbd18151968ceefbe06">cy_en_usbfs_dev_drv_lpm_req_t</a> for the set of options. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaa199d2bde362568ca193e437fa587a25"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa199d2bde362568ca193e437fa587a25">&#9670;&nbsp;</a></span>Cy_USBFS_Dev_Drv_Lpm_GetResponse()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__STATIC_INLINE <a class="el" href="group__group__usbfs__dev__drv__enums.html#ga7e78856f9225afbd18151968ceefbe06">cy_en_usbfs_dev_drv_lpm_req_t</a> Cy_USBFS_Dev_Drv_Lpm_GetResponse </td>
          <td>(</td>
          <td class="paramtype">USBFS_Type const *&#160;</td>
          <td class="paramname"><em>base</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the response value that the device sends as part of the handshake packet when an LPM token packet is received. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">base</td><td>The pointer to the USBFS instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The response to return for an LPM token packet. See <a class="el" href="group__group__usbfs__dev__drv__enums.html#ga7e78856f9225afbd18151968ceefbe06">cy_en_usbfs_dev_drv_lpm_req_t</a> for the set of options. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
